SymmetricDifference Method

Wintellect PowerCollections

Collapse imageExpand ImageCollapseAll imageExpandAll imageDropDown imageDropDownHover imageCopy imageCopyHover image
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Computes the symmetric difference of this bag with another bag. The symmetric difference of two bags is all items that appear in either of the bags, but not both. If an item appears X times in one bag, and Y times in the other bag, the symmetric difference contains the item AbsoluteValue(X - Y times). A new bag is created with the symmetric difference of the bags and is returned. This bag and the other bag are unchanged.

Namespace: Wintellect.PowerCollections
Assembly:  PowerCollections (in PowerCollections.dll)

Syntax

C#
public OrderedBag<T> SymmetricDifference(
	OrderedBag<T> otherBag
)
Visual Basic (Declaration)
Public Function SymmetricDifference ( _
	otherBag As OrderedBag(Of T) _
) As OrderedBag(Of T)
Visual C++
public:
OrderedBag<T>^ SymmetricDifference (
	OrderedBag<T>^ otherBag
)

Parameters

otherBag
OrderedBag<(Of <T>)>
Bag to symmetric difference with.

Return Value

The symmetric difference of the two bags.

Remarks

The symmetric difference of two bags is computed in time O(M + N), where M is the size of the larger bag, and N is the size of the smaller bag.

Exceptions

ExceptionCondition
System..::InvalidOperationExceptionThis bag and otherBag don't use the same method for comparing items.
System..::ArgumentNullExceptionotherBag is null.

See Also